ID-Card API Documentation#

On this page

We provide a test-environment for Merchants to test the integration. It includes test users with different age and genders, so that we can generate QRCodes for testing purposes.

Session Response Model#

We only return the data requested by the scope provided in the access token. The content of the response model will then very depending on the Merchants needs, but a full model looks like this:

Session Response Model

{
    "firstName": "string",
    "lastName": "string",
    "documentPhoto": "string",
    "age": int,
    "phoneNumber": "string"
}

Here is a table of what you can expect to be returned depending on your scope. All properties will be returned at all times, but the value will be empty if its not part of your scope.

Name	Type	Description	age_only	identity_basic	picture_age	identity_full	phone_number
firstName	string	First name	❌	✅	❌	✅	❌
lastName	string	Last name	❌	✅	❌	✅	❌
documentPhoto	string (base64)	Identity document's photograph	❌	❌	✅	✅	❌
age	string	Age of user	✅	✅	✅	✅	❌
phoneNumber	string	Phone number with country code (47)	❌	❌	❌	❌	✅

Environments#

ID-Card API is available through different base URLs for our different environments. To access the API, combine the base URL + endpoint like this: base URL + /api/merchant/session/.

Environment URLs - Test#

ID-Card Base URL: https://visleg-test-merchantservice-cnhvehb0cvdgggah.z01.azurefd.net
BankID OIDC Config: https://auth.current.bankid.no/auth/realms/current/.well-known/openid-configuration

Environment URLs - Production#

ID-Card Base URL: SENT PRIVATELY
BankID OIDC Config: https://auth.bankid.no/auth/realms/prod/.well-known/openid-configuration

Merchant Integration API#

.css-3yoqq2{color:var(--stoe-colors-fg-color-subtle);font-family:'Inter','Inter Fallback';margin-bottom:0rem;font-size:1rem;font-weight:400;line-height:1.5;text-align:start;}The API reference needs JavaScript. Download the OpenAPI specification instead.